﻿<!DOCTYPE html>
<html>
<head>
    <title>Scribd Helper for WebMatrix - Reference</title>
    <link href="content/Site.css" rel="stylesheet" type="text/css" />
    <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
</head>
<body>
    <div class="container">
        <div class="header">
            <img src="content/images/webx-icon.png" alt="WebMatrix" />
            <img src="content/images/scribd-logo.png" alt="Scribd Logo" class="partnerLogo" />
            <h1>
                Microsoft WebMatrix Helpers</h1>
            <h2>
                Scribd Helper - Reference</h2>
        </div>
        <div class="content">
            <div class="navLinks">
                <a href="startHere.htm">Start Here</a> | <a href="reference.htm">Helper Reference</a>
            </div>
            <h3>Helper Methods</h3>
			<p><em>Note: Current version does not support the full Scribd API.</em></p>
            <table class="memberdecls">
                <tr>
                    <td class="memItemLeft">
                        static void
                    </td>
                    <td class="memItemRight">
                        <strong>Initialize</strong> (string apiKey)
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Initializes the Scribd helper with the Scribd API key.                        
                    </td>
                </tr>              
                <tr>
                    <td class="memItemLeft">
                        static IList&lt;<a href="#Document">Document</a>&gt;
                    </td>
                    <td class="memItemRight">
                        <strong>GetFeaturedDocuments</strong> ([int limit],
                                            [int offset],
                                            [string scope])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Retrieves the list of featured Scribd documents (for all users).
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static IList&lt;<a href="#Document">Document</a>&gt;
                    </td>
                    <td class="memItemRight">
                        <strong>GetUserDocuments</strong> ([int limit],
                                            [int offset])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Retrieves a list of the user's documents.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        static string
                    </td>
                    <td class="memItemRight">
                        <strong>GetThumbnailUrl</strong> (int documentId, [int width], [int height])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Retrieves a URL to the thumbnail of a document, in a given size.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        @helper
                    </td>
                    <td class="memItemRight">
                        <strong>GetFeaturedDocumentsWidget</strong> ([int limit],
                                   [int offset],
                                   [string scope],
                                   [int pageSize])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Displays a widget that lists the Scribd featured documents. It allows the user to view the document by using the Scribd reader.
                    </td>
                </tr>
                <tr>
                    <td class="memItemLeft">
                        @helper
                    </td>
                    <td class="memItemRight">
                        <strong>GetUserDocumentsWidget</strong> ([int limit],
                               [int offset],                                
                               [int pageSize])
                    </td>
                </tr>
                <tr>
                    <td class="mdescLeft">
                        &nbsp;
                    </td>
                    <td class="mdescRight">
                        Displays a widget that lists the user's documents. It allows the user to view the document by using the Scribd reader.
                    </td>
                </tr>
                <tr><td class="memItemLeft"></td><td class="memItemRight"></td></tr>                
            </table>
            <h4 id="Document">
                Document Information</h4>
            <table class="memberdecls">
                <tr>
                    <td width="183" class="memItemRight">
                        int <strong>DocId</strong>
                    </td>
                    <td width="625" class="memItemRight">
                        The document id. Every document on Scribd has a unique document ID.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>AccessKey</strong>
                    </td>
                    <td class="memItemRight">
                        Every document on Scribd has a unique, secure access key. You must know the access key of a document to embed it.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Title</strong>
                    </td>
                    <td class="memItemRight">
                        The document title.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>Description</strong>
                    </td>
                    <td class="memItemRight">
                        The document description.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>DescriptionSummary</strong>
                    </td>
                    <td class="memItemRight">
                        The document description, limited to 35 words.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>ThumbnailUrl</strong>
                    </td>
                    <td class="memItemRight">
                        Link to a JPG that contains a thumbnail of the document. This can be used to make search results more presentable. Do not cache thumbnail URLs - they are subject to change.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string[] <strong>Tags</strong>
                    </td>
                    <td class="memItemRight">
                        Comma separated list of tags for the document.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>License</strong>
                    </td>
                    <td class="memItemRight">
                        See Wikipedia:Creative_Commons_License. "c" is traditional copyright. "pd" is public domain.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>PageCount</strong>
                    </td>
                    <td class="memItemRight">
                        The number of pages in the document.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string[] <strong>DownloadFormats</strong>
                    </td>
                    <td class="memItemRight">
                        List of downloadable extensions.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        int <strong>Reads</strong>
                    </td>
                    <td class="memItemRight">
                        Number of reads.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        string <strong>UploadedBy</strong>
                    </td>
                    <td class="memItemRight">
                        The username of the user who uploaded this document.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>WhenUploaded</strong>
                    </td>
                    <td class="memItemRight">
                        The date the document was originally uploaded.
                    </td>
                </tr>
                <tr>
                    <td class="memItemRight">
                        DateTime <strong>WhenUpdated</strong>
                    </td>
                    <td class="memItemRight">
                        The date this document was last updated.
                    </td>
                </tr>
		<tr><td class="memItemLeft"></td><td class="memItemRight"></td></tr>              
            </table>
        </div>
        <ul class="footer">
            <li>We're always looking for <a href="mailto:webapp@microsoft.com">bugs, feedback and
                suggestions!</a></li>
            <li>&copy; 2010-2011 Microsoft Corporation. Powered by IIS Express.</li>
        </ul>
    </div>
</body>
</html>
